home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 557 / lharc / man.eng < prev    next >
Text File  |  1991-10-13  |  14KB  |  436 lines
  1.       User's Manual for High-Performance File-Compression Program
  2.  
  3.               LHarc Version 1.13c
  4.                 05/31/89
  5.  
  6.  
  7.        Copyright (c) Haruyasu Yoshizaki (Yoshi), 1988-89
  8.  
  9.  
  10. (This manual is dramtically shortend, use it as an "emergency-manual"
  11. if you recieived LHarc with no docs)
  12.  
  13. 1. How to Use It:
  14.  
  15.    Just type "LHarc" to see a concise help screen of the program's
  16.    command structure.
  17.  
  18.  
  19.    Command-line synopsis:
  20.    ======================
  21.  
  22.    LHarc [<command>] [{{/|-}{<switch>[-|+|2|<option>]}}...] <archive_name>
  23.      [{&}{<drive_name>:}|{<home_directory_name>\}] [<path_name> ...]
  24.  
  25.    Only a single command can be specified on the command line, but a
  26.    group of switches can be specified together after the '/' or '-'
  27.    delimiter.  You may place switch(es) anywhere following the command.
  28.  
  29.    Hitting 'Ctrl-Break' or 'Ctrl-C' at any time will abort LHarc's
  30.    current operation and return you to the DOS prompt.
  31.  
  32.    If the first character of a filename is &, all the file is assumed to
  33.    contain filenames. &- reads filenanmes from stdin. Example:
  34.  
  35.     lzh_c.txt contains:
  36.     LHARC.C
  37.     LZHSS.C
  38.     UTIL.C
  39.  
  40.     the command a test &lzh_c.txt is aquivalent to a test lharc.c lzhss.c
  41.     util.c
  42.  
  43.    Commands:
  44.    =========
  45.  
  46.    a (Add files to archive)
  47.  
  48.      LHarc a ARCHIVE.LZH file1.ext
  49.  
  50.     Adds 'file1.ext' to 'ARCHIVE.LZH'.  If 'ARCHIVE.LZH' does
  51.     not exist, then LHarc will create it.  If a file with the
  52.     name 'file1.ext' already exists in the archive, LHarc will
  53.     replace it with the specified file.
  54.  
  55.    u (Update files to archive)
  56.  
  57.      LHarc u ARCHIVE.LZH file1.ext
  58.  
  59.     Adds 'file1.ext' to 'ARCHIVE.LZH', the same as with the 'a'
  60.     command.  However, if 'file1.ext' already exists in the
  61.     archive, LHarc will check its time stamp and will keep the
  62.     newer one and ignore the older one.  (Use the /c switch to
  63.     tell LHarc to skip this time-stamp comparison.)
  64.  
  65.    m (Move new files into archive)
  66.  
  67.      LHarc m ARCHIVE.LZH file1.ext
  68.  
  69.     is equivalent to
  70.  
  71.      LHarc u ARCHIVE.LZH file1.ext
  72.      DEL file1.ext
  73.  
  74.     Beware the fact that the second line is implicit.  You might
  75.     lose 'file1.ext' forever.
  76.  
  77.    f (Freshen files in archive)
  78.  
  79.      LHarc f ARCHIVE.LZH file1.ext
  80.  
  81.     Replaces 'file1.ext' in 'ARCHIVE.LZH' with the newer one
  82.     only if a file with this name already exists in the archive.
  83.     Otherwise, no action is taken.    (Use the /c switch to tell
  84.     LHarc to skip this time-stamp comparison.)
  85.  
  86.    e or x (EXtract files from archive)
  87.  
  88.      LHarc e ARCHIVE.LZH d:\temp\
  89.  
  90.     Extracts all the files from 'ARCHIVE.LZH
  91.     directory \temp\ on drive D:.  
  92.  
  93.      LHarc e ARCHIVE.LZH file1.ext
  94.  
  95.     Extracts only 'file1.ext' from 'ARCHIVE.LZH'.  If a file
  96.     with the name 'file1.ext' exists in the home directory,
  97.     LHarc will compare their time stamps and if the existing
  98.     file is older, then LHarc will prompt you whether to
  99.     overwrite it.  (Use the /c switch to tell LHarc to skip this
  100.     time-stamp comparison.)
  101.  
  102.  
  103.    p (disPlay files in archive)
  104.  
  105.      LHarc p ARCHIVE.LZH file1.ext
  106.  
  107.     Extracts 'file1.ext' from 'ARCHIVE.LZH' and redirects it to
  108.     standard output.
  109.  
  110.  
  111.    d (Delete files from archive)
  112.  
  113.      LHarc d ARCHIVE.LZH file1.ext
  114.  
  115.     Deletes 'file1.ext' from 'ARCHIVE.LZH'.
  116.  
  117.    l (List files in archive)
  118.  
  119.      LHarc l ARCHIVE.LZH
  120.  
  121.     Lists information about all the files in 'ARCHIVE.LZH':
  122.     name, original size, stored size, etc. Each file takes one
  123.     line of output.  A '+' before a file name indicates that a
  124.     directory name is stored with the file name. 
  125.  
  126.    v (View list of files in archive)
  127.  
  128.      LHarc v ARCHIVE.LZH
  129.  
  130.     Lists information about all the files in 'ARCHIVE.LZH',
  131.     except that each listing takes two lines: the first for the
  132.     full path name and the second for the rest of the
  133.     information.  
  134.  
  135.    t (Test integrity of archive)
  136.  
  137.      LHarc t ARCHIVE.LZH
  138.  
  139.     Tests the integrity of 'ARCHIVE.LZH' by running a CRC check
  140.     on each file and comparing the result against the file's
  141.     stored CRC value.
  142.  
  143.  
  144.      LHarc ARCHIVE.LZH
  145.  
  146.     Acts exactly the same as the 'x' command.  This optional
  147.     action is temporary.  Don't count on it in future versions.
  148.  
  149.    Switches:
  150.    =========
  151.  
  152.    Specify switch(es) following the switch delimiter '/' or '-'.  If
  153.    you want to specify more than one switch, type characters
  154.    continuously without any intervening spaces, like "/rx-we:\work" or
  155.    "/cxvless".    When the 'v' and 'w' switches are used with other
  156.    switches, they must be specified at the end of a sequence, as shown
  157.    in the above examples.
  158.  
  159.    You may place a '+' or '-' sign after switches, with the following
  160.    meanings: '+' turns the switch on and '-' turns the switch off.
  161.    The '2' creates a special option for the /r and /v switches (see
  162.    below).  If you just specify /<switch> without '+' or '-', then
  163.    <switch> will be toggled from 'on' to 'off' or vice versa, e.g., to
  164.    override any switch set in an environment variable (see below).
  165.  
  166.    NOTE:  Use only lowercase letters for switches.  Capital letters
  167.       are reserved for future use.
  168.  
  169.  
  170.      /x[-|+] (allow eXtended file names)
  171.  
  172.     By default, LHarc stores only the file names of archived
  173.     files and disregards the names of the directory(s) in which
  174.     they reside.  This switch tells LHarc to extend all file
  175.     names with directory names and to extract archived files
  176.     together with their stored directory names.
  177.  
  178.  
  179.      /p[-|+] (distinguish full Path names)
  180.  
  181.     By default, LHarc disregards directory names when extracting
  182.     files.    This switch tells LHarc to distinguish files by full
  183.     path name during un-archiving.
  184.  
  185.  
  186.      /c[-|+] (skip time-stamp Comparison)
  187.  
  188.      LHarc [e|f|u|x] /c ARCHIVE.LZH [file1.ext file2.ext ...]
  189.  
  190.     If a file with the same name is to be created, LHarc will
  191.     default to comparing the time stamp of each pair of files,
  192.     and so some files will be overwritten and some just ignored.
  193.     This switch tells LHarc to overwrite any existing files with
  194.     extracted ones with the same name.
  195.  
  196.  
  197.      /m[-|+] (no Message for query)
  198.  
  199.      LHarc [<command>] /m ARCHIVE.LZH [file1.ext file2.ext ...]
  200.  
  201.     By default, before operations that alter files or
  202.     directories, LHarc will query you with messages like
  203.     "Overwrite? [Y/N]".  This switch suppresses these messages
  204.     and tells LHarc to proceed as if "y" is typed in.
  205.  
  206.  
  207.      /a[-|+] (allow any Attribute of files)
  208.  
  209.      LHarc a /a ARCHIVE.LZH file1.arc
  210.  
  211.     adds 'file1.arc' to 'ARCHIVE.LZH'.
  212.  
  213.     By default, LHarc will not archive files with the hidden,
  214.     read-only or system attribute.    This switch tells LHarc
  215.     also to archive files with these attributes.
  216.  
  217.  
  218.      /r[-|+|2] (Recursively collect files)
  219.  
  220.  
  221.      LHarc has three modes of collecting the files to be archived:
  222.  
  223.     (a) specified file(s):    /r-
  224.  
  225.         LHarc a /r- ARCHIVE.LZH file1.ext [file2.ext ...]
  226.  
  227.          Adds to 'ARCHIVE.LZH' only the specified files
  228.          (default mode).
  229.  
  230.     (b) across directories:  /r or /r+
  231.  
  232.         LHarc a /r ARCHIVE.LZH *.c
  233.  
  234.          Adds to 'ARCHIVE.LZH' all the files with
  235.          extension .C on the current drive, starting
  236.          from the current directory.  LHarc will store
  237.          all file names extended with directory names.
  238.          Use this switch to archive all versions of a
  239.          file or all files of a certain type.
  240.  
  241.     (c) specified directory(s):  /r2
  242.  
  243.         LHarc a /r2 ARCHIVE.LZH \doc
  244.  
  245.          Adds to 'ARCHIVE.LZH' all the files in the
  246.          directory specified by the path \doc and its
  247.          branches, similar to the Unix -r option.  Use
  248.          this switch to archive complete directories.
  249.  
  250.     The /r and /r2 switches set the /x switch simultaneously.
  251.     You may have to toggle the /x switch off (with /x-) after
  252.     using /r or /r2.  The /x- switch tells LHarc to disregard
  253.     stored directory names.
  254.  
  255.  
  256.      /w[-|+|<directory_name>] (set Working directory)
  257.  
  258.      LHarc a /w[d:\temp] ARCHIVE.LZH [file1.ext file2.ext ...]
  259.  
  260.     Creates all the temporary files for 'ARCHIVE.LZH' in the
  261.     directory \temp\ on drive D:.  If no directory name is
  262.     specified with this switch, then the current directory
  263.     becomes the working directory and all the temporary files
  264.     created in the process of archiving will reside in this
  265.     directory and be deleted afterward.
  266.  
  267.      Use the /w switch when
  268.  
  269.     (1) you have no room in the directory where the archive is,
  270.         or
  271.     (2) you want your work done silently and swiftly on a RAM
  272.         disk.
  273.  
  274.     This switch overrides the working directory that may be
  275.     specified in an environment variable (see below).
  276.  
  277.  
  278.      /v[-|+|2|<utility_name>] (View file by another utility)
  279.  
  280.      LHarc p /v ARCHIVE.LZH file1.ext
  281.  
  282.     Extracts 'file1.ext' from 'ARCHIVE.LZH' and invokes the
  283.     default utility LESS for formatted display to standard
  284.     output.
  285.  
  286.     LHarc first creates an un-archived file 'LHARC.TMP' and then
  287.     invokes the specified utility, usually a page formatter like
  288.     LIST.PRG or SEE.PRG.  
  289.  
  290.      /n[-|+] (No Indicator)
  291.  
  292.     Suppress progress display oooo... in the process of
  293.     archiving and de-archiving.  The display is on the standard
  294.     error stream so that the dsiplay is on even in the process
  295.     of redirection.
  296.  
  297.      /t[-|+] (Time Stamp)
  298.  
  299.     Update the time stamps of Archive to the newest file in the
  300.     archive, effective with switches (a,u,m,f,d).
  301.  
  302.      /l         (Generate Larc-style-archive)
  303.  
  304.     The file is compressed without Huffman, the code will be about
  305.         5% longer than a normal 1.13-archiv but the compression and 
  306.      decompression is much faster. This is the format used in PFXPAK.
  307.     PFXPAK and Larclib are able to decode this type of files at a 
  308.     rate of about 100KB per second.
  309.  
  310.      /o      (Generate LHarc 1.13-style-archvie)
  311.  
  312.     Using this switch tells LHarc to use compression-method used in 
  313.     LHarc 1.13. Use this switch, if the archive may be extracted on
  314.     other machines than atari st or ibm pc.
  315.  
  316.      /k      (Generate compatible headers)
  317.  
  318.     LHarc 2.x automatically generates an extended-header of size 
  319.     Zero. Some versions of LHarc may not be able to extract files
  320.     with extended headers. Using -ok will gernerate full compatible
  321.     archives.
  322.  
  323.      /u     (Store without compression)
  324.  
  325.     The files are stored to the archiv without compression.
  326.     
  327.  
  328.    Home directory name (drive name):
  329.    =================================
  330.  
  331.    If you specify a home directory name, then LHarc will refer to that
  332.    directory as if it is the current directory.  Specify a home
  333.    directory name ending with either '\' or ':'.  All files will be
  334.    archived without storing this directory name unless you also use the
  335.    /r or /x switch.
  336.  
  337.  
  338.    File name (path name):
  339.    ======================
  340.  
  341.    The file names or path names of files to be archived must be
  342.    specified or else LHarc will assume *.* with no directory names.
  343.    The wildcards '*' and '?' behave exactly as in DOS.    You cannot use
  344.    them to specify directories except with the /r2 switch, similar to
  345.    the Unix -r option for cp, mv and rm.
  346.  
  347.  
  348. 2. Setting Switches in an Environment Variable
  349.  
  350.    You may set any of LHarc's default switches with the environment
  351.    variable 'LHARC':
  352.  
  353.      SET LHARC=/we: /r2
  354.  
  355.     will set drive E: as the working directory and archive all
  356.     files in directory mode.
  357.  
  358.    You may also specify LHarc's working directory with the environment
  359.    variable 'TMP':
  360.  
  361.      SET TMP=E:
  362.  
  363.     but the /w switch will override this setting.
  364.  
  365.  
  366. 5. Result Codes
  367.  
  368.    LHarc returns the following result codes to the parent process:
  369.  
  370.     0   Normally finished.
  371.  
  372.     1   Process finished with nonexistent file names ignored
  373.         during archiving or CRC error occurred during
  374.         un-archiving.
  375.  
  376.     2   Process terminated by fatal error; no archive created
  377.         or files moved.
  378.  
  379.     3   Unable to write temporary files into the archive.  Work
  380.         file renamed to 'LHARC.)2(' and original archive
  381.         deleted.  Try renaming LHARC.)2( as your archive,
  382.         although it might be damaged.
  383.  
  384.  
  385. 6. Temporary Files
  386.  
  387.     LHARC.)1(   Original archive, renamed.
  388.     LHARC.)2(   Work file used to create new archive.
  389.     LHARC.TMP   Work file created for viewing by another utility.
  390.  
  391.    If a file with one of these file names already exists in the working
  392.    directory, then the behavior of LHarc is unpredictable.
  393.  
  394. 7. My Distribution Policy
  395.  
  396.    Under the following conditions, you may freely copy and distribute
  397.    this software:
  398.  
  399.    1. Under all circumstances, "Copyright by Haruyasu Yoshizaki"
  400.       must be attached to the copy.
  401.  
  402.    2. The manual LHarc.MAN or its hardcopy should go together with the
  403.       software. (Not this short version!)
  404.  
  405.    3. You may modify the program, but in that case, you must distri-
  406.       bute the complete source code for the program, including your
  407.       specific contributions and you must make it clear that you
  408.       have made such modifications.
  409.  
  410.    4. You must try to distribute the latest version available.
  411.  
  412.    5. I assume no warranty for any claim of damage you may sustain
  413.       by using this software.
  414.  
  415.    6. I have no obligation to revise the program to correct any
  416.       fault in this software.
  417.  
  418.    7. For any commercial use of this software, I add the following:
  419.  
  420.       a. The entire software made incorporating this program should
  421.      not be copy protected in the sense that the DISKCOPY
  422.      program of MS-DOS makes an imperfect copy.
  423.  
  424.       b. Every part of the package should print the name "LHarc" and
  425.      the copyright banner.
  426.  
  427.       c. The distribution policy of this software should be printed
  428.      either in the manual, in the package or on the disk label.
  429.  
  430.      Comment:  If a commercial package or a shareware
  431.            product uses LHarc with self-extracting SFX
  432.            form for the distribution, then the Copy-
  433.            right statement must appear with SFX header.
  434.            I consider this as a claim of LHarc's Banner.
  435.  
  436.